home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / gnu / emacs_src.lha / emacs-18.58 / contrib / dgay / README < prev   
Lisp/Scheme  |  1992-10-01  |  2KB  |  51 lines
  1. dtags allows you to quickly lookup the autodocs for the AmigaOS functions
  2. while programming. It is a modification of the emacs TAGS facility.
  3.  
  4. For example, you have forgotten the parameters for MakeLink. Your buffer contains:
  5.  
  6.   if (MakeLink(
  7.  
  8. you press the magic key (in my case M-g), and you get in an other buffer:
  9.  
  10. dos.library/MakeLink                                     dos.library/MakeLink
  11.  
  12.    NAME
  13.     MakeLink -- Creates a filesystem link (V36)
  14.  
  15.    SYNOPSIS
  16.    [...]
  17.  
  18. which should solve all your problems ...
  19.  
  20. To install this facility, you must:
  21.  
  22. a) Have an assign of DOCS: to the directory containing the AmigaOS 2.0 autodocs.
  23.  
  24. b) Copy dtags.el and dtags.elc to your lisp directory (probably gnuemacs:lisp).
  25.  
  26. c) Execute the make-dtags.el file once (with M-x load-file). This will create
  27. a file called DTAGS in DOCS: to help emacs find the functions in the autodocs.
  28.  
  29. d) Add the following lines to your .emacs file:
  30.  
  31. (autoload 'visit-dtags-table "dtags" nil t)
  32. (autoload 'doc-tag "dtags" nil t)
  33. (autoload 'dtags-search "dtags" nil t)
  34. (autoload 'list-dtags "dtags" nil t)
  35. (autoload 'dtags-apropos "dtags" nil t)
  36. (autoload 'make-dtags "dtags" nil t)
  37.  
  38. and optionally a key definition to execute doc-tag (the autodoc lookup function):
  39.  
  40. (define-key global-map "\M-g" 'doc-tag)
  41.  
  42. Usage:
  43. -----
  44.  
  45. You just press M-g (if you chose that key). Emacs will prompt you for the
  46. function to lookup, but it will propose as a default a word near your
  47. cursor. Once this has been chosen, emacs will display the appropriate autodoc.
  48. You can enter a substring of the function name, in which case emacs will display
  49. the first one that matches it. If you want to see other functions containing the
  50. same substring, press M-, (or M-x tags-loop-continue).
  51.